Repository navigation
docs: rebuild the guarantee ledger as docs/guarantees/ (guarantee-audit) - #43
Merged
Merged
Conversation
1ファイルの docs/guarantees.md を、約束の対象ごとのファイルと README からなる docs/guarantees/ へ組み直す。宣言と要約の表を表の1行に畳み、1行に約束1つへ分ける。テストで裏付けの無い部分は Gaps へ移す。台帳を指すリンクと pr-workflow の手順を新しい置き場へ直す。
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
1ファイルの
docs/guarantees.mdを、guarantee-audit の形のdocs/guarantees/へ組み直す。新しい約束もテストも足していない。変更内容
docs/guarantees/README.mdに目的・分け方・書き方・引き方・運用・Files・Gaps を置き、About をやめた(対象範囲は冒頭へ。地位は README の Design Decisions と同格とした)build(走査・トップ・ディレクトリとファイルのページ・画像と HTML)・links(生成したページのリンク・Markdown 本文のリンク・GitHub の URL・画像の参照)・incremental・config(設定の検証)・issues・plugins(拡張のインターフェース)・publish・sessions(例の拡張)。旧 §1 は対象が多いので build / links / incremental / config に分け、旧 §3 の設定の誤りは config へ、旧 §4 のcheck_every_hoursの検証も config へ寄せた##の見出しで分けた(plugins.md だけ6行で見出しなし)test_links_are_relative_and_resolveには置き場(tests/test_build.py/tests/test_example_sessions.py)を添えた.claude/skills/pr-workflow/SKILL.mdの台帳のパスと更新の手順を新しい置き場へ直した。issues/done/は記録なので残したdocs/guarantees.mdを消したGaps へ移したもの(テストを読んで裏付けが無かった部分)
test_readme_on_directory_pageは案内文が出ない側しか見ていない--incrementalの入力のうち、置き場所・アカウント・本体のコード・[scan.repos]以外の設定・Issue の一覧: テストは HEAD・他のリポ・[scan.repos]・拡張のtargetsの変化だけcheck_every_hoursの起動のずれの見込みが5分であること: テストは1分短い場合と直後しか見ていないwaitsの表示がリンクであること: テストはwaits on <リポ> #<番号>の文字しか見ていない。表の行は「文字として出る」に改めた内部実装として台帳に載せないテスト
なし。全テストが表に出ており、表に挙げたテスト名はすべて実在する(照合済み)。
迷った仕分け
[scan.repos]の値が表でなければ止める、[scan.repos]を変えると--incrementalも作り直す、セッションのページの左に件数を出さない)は、テストがあるので表の行にした。件数を出さない理由(使い回しのため)は書いていないissues.mdの「Issue のページのリンクは相対パス」とsessions.mdの同じ約束は、links.mdに集めず各ファイルに残した。テストもページも別で、落ちたテストの名前から行が1つに決まるためerror:・非0・public/を作らない、の3つは「ビルドの前に止まる」1つの約束として1行のままにした--incrementalの約束はbuildからincremental.mdへ切り出した。publishも使うため、別の対象とした確認
nix develop -c pytest -q: 89 passed